/*
 * Copyright 2024 LinQingYing. and contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * The use of this source code is governed by the Apache License 2.0,
 * which allows users to freely use, modify, and distribute the code,
 * provided they adhere to the terms of the license.
 *
 * The software is provided "as-is", and the authors are not responsible for
 * any damages or issues arising from its use.
 *
 */

package com.linqingying.cangjie.references

import com.linqingying.cangjie.name.FqName
import com.intellij.psi.PsiElement

/**
 * Service that is responsible for mutating PSI through [CjReference].
 *
 * This service is only needed by IDE to handle element renaming or change elements bound to a [CjReference].
 */
interface CjReferenceMutateService {
    /**
     * See [com.intellij.psi.PsiReference.handleElementRename].
     */
    fun handleElementRename(cjReference: CjReference, newElementName: String): PsiElement?

    /**
     * See [com.intellij.psi.PsiReference.bindToElement].
     */
    fun bindToElement(cjReference: CjReference, element: PsiElement): PsiElement

    fun bindToElement(simpleNameReference: CjSimpleNameReference, element: PsiElement, shorteningMode: CjSimpleNameReference.ShorteningMode): PsiElement

    fun bindToFqName(
        simpleNameReference: CjSimpleNameReference,
        fqName: FqName,
        shorteningMode: CjSimpleNameReference.ShorteningMode = CjSimpleNameReference.ShorteningMode.DELAYED_SHORTENING,
        targetElement: PsiElement? = null
    ): PsiElement
}
